<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
	<!--[if lt IE 9]>
	<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
    <title>NavigationChoice_V1 - Pws.Clients.RestLibrary Documentation</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
    <link type="text/css" rel="stylesheet" href="../main.css"/>
    <script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
    <script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
    <script type="text/javascript" src="../js/navigation.js"></script>
    <script type="text/javascript" src="../js/example.js"></script>
  </head>
  <body>
  	<header><h1>Pws.Clients.RestLibrary : API Documentation</h1>
	</header>
<nav id="namespaces">
	<h2 class="fixed">Namespaces</h2>
	<div class="scroll">
		<ul>
			<li>
          <a href="../Pws.Clients.RestLibrary/index.htm">Pws.Clients.RestLibrary</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Aftersales/index.htm">Pws.Clients.RestLibrary.Aftersales</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers/index.htm">Pws.Clients.RestLibrary.Customers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Contacts/index.htm">Pws.Clients.RestLibrary.Customers.Contacts</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Orders/index.htm">Pws.Clients.RestLibrary.Customers.Orders</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Products/index.htm">Pws.Clients.RestLibrary.Customers.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Permissions/index.htm">Pws.Clients.RestLibrary.ECommerce.Permissions</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Users/index.htm">Pws.Clients.RestLibrary.ECommerce.Users</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Framework/index.htm">Pws.Clients.RestLibrary.Framework</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products/index.htm">Pws.Clients.RestLibrary.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products.Navigation/index.htm" class="current">Pws.Clients.RestLibrary.Products.Navigation</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Shared/index.htm">Pws.Clients.RestLibrary.Shared</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Suppliers/index.htm">Pws.Clients.RestLibrary.Suppliers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceEstimator/index.htm">Pws.Clients.RestLibrary.WorksurfaceEstimator</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceJobs/index.htm">Pws.Clients.RestLibrary.WorksurfaceJobs</a>
      </li>
		</ul>
	</div>
</nav><nav id="types">
  <h2 class="fixed">Types in Pws.Clients.RestLibrary.Products.Navigation</h2>
	<div class="scroll">
		<ul>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm" class="current">NavigationChoice_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/NextCategoryChoice.htm">NextCategoryChoice</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/NextClassificationChoice.htm">NextClassificationChoice</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/PreviousCategoryChoice.htm">PreviousCategoryChoice</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/PreviousClassificationChoice.htm">PreviousClassificationChoice</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/SearchTerms.htm">SearchTerms</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/VisualFlag.htm">VisualFlag</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Products.Navigation/WebPageLink.htm">WebPageLink</a>
        </li>
		</ul>
	</div>
</nav>
	<article>
    <header>
		<p class="class"><strong>Type</strong> NavigationChoice_V1</p>
	</header>
	<section>
		<header>
		<p><strong>Namespace</strong> Pws.Clients.RestLibrary.Products.Navigation</p>
		<p><strong>Interfaces</strong> <a href="../Pws.Clients.RestLibrary/IPwsObject_V1.htm">IPwsObject_V1</a></p>
		</header>
    <div class="sub-header">
			<div id="summary">A method of navigating through the PWS Product Catalogue. A series of filter options is presented in the form of Classifications (e.g. "Colour") with
contained Category choices (e.g. "Red"). By following the link contained within, the PWS REST Services returns another NavigationChoice object which represents
a list of products filtered appropriately by that Category. This effectively represents state information for a user who is navigating through the catalogue,
and allows the client application to present a list of filters, optionally with corresponding products. <blockquote class="remarks">
  application/x.pws.products.navigation.navigationchoice-v1 
</blockquote>
			</div>
		
		
		
			<h3 class="section">Properties</h3>
			<ul>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#Description">Description</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#IsProductListPermitted">IsProductListPermitted</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#IsProductListRecommended">IsProductListRecommended</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#Links">Links</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#Name">Name</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#NextChoices">NextChoices</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#PreviousChoices">PreviousChoices</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#ProductList">ProductList</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#ProductListCount">ProductListCount</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#PromotionalChoices">PromotionalChoices</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#QuickOrderChoices">QuickOrderChoices</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#RequestedSearch">RequestedSearch</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#Resources">Resources</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#Searches">Searches</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#VisualFlags">VisualFlags</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Products.Navigation/NavigationChoice_V1.htm#WebPageLinks">WebPageLinks</a></li>
			</ul>
		
	</div>
	
	
	
	<h3 class="section">Public properties</h3>

	<div id="Description" class="method">
		<h4>
			<span title="System.string">string</span> <strong>Description</strong> get; set;
		</h4>
		<div class="content">A human-readable description for this position within the navigation hierarchy. 

		</div>
	</div>
	<div id="IsProductListPermitted" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsProductListPermitted</strong> get; set;
		</h4>
		<div class="content">This will be true if the navigation permits displaying a full list of products at this point, regardless of whether it's the recommended way for a user to browse the product list.
If this is false, then presenting the user with a list of products is strongly discouraged.
Use in combination with IsProductListRecommended. 

		</div>
	</div>
	<div id="IsProductListRecommended" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsProductListRecommended</strong> get; set;
		</h4>
		<div class="content">This will be true if the navigation recommends displaying a full list of products at this point.
If this is false, then it is recommended just to display the next list of choices (via NextNavigationChoices) instead. 

		</div>
	</div>
	<div id="Links" class="method">
		<h4>
			<span title="System.Collections.Generic.List<Link_V1>">List&lt;Link_V1&gt;</span> <strong>Links</strong> get; set;
		</h4>
		<div class="content">A link which will retrieve the object again. 

		</div>
	</div>
	<div id="Name" class="method">
		<h4>
			<span title="System.string">string</span> <strong>Name</strong> get; set;
		</h4>
		<div class="content">A human-readable name for this position within the navigation hierarchy. 

		</div>
	</div>
	<div id="NextChoices" class="method">
		<h4>
			<span title="System.Collections.Generic.List<NextClassificationChoice>">List&lt;NextClassificationChoice&gt;</span> <strong>NextChoices</strong> get; set;
		</h4>
		<div class="content">A list of the next available choices, in terms of the Classifications and their Categories.
To narrow down the list of displayed products, follow one of the NavigationChoice links that is contained within. 

		</div>
	</div>
	<div id="PreviousChoices" class="method">
		<h4>
			<span title="System.Collections.Generic.List<PreviousClassificationChoice>">List&lt;PreviousClassificationChoice&gt;</span> <strong>PreviousChoices</strong> get; set;
		</h4>
		<div class="content">A list of the previous choices made, in terms of the Classification and their Categories.
To widen the list of displayed products by removing a previously selected filter, follow one of the Navigation choice links that is contained within. 

		</div>
	</div>
	<div id="ProductList" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>ProductList</strong> get; set;
		</h4>
		<div class="content">A link to a list of products available within the set which has been filtered so far. <blockquote class="remarks">
  application/x.pws.products.productinformation[] 
</blockquote>

		</div>
	</div>
	<div id="ProductListCount" class="method">
		<h4>
			<span title="System.int">int</span> <strong>ProductListCount</strong> get; set;
		</h4>
		<div class="content">The number of products that will be returned by the ProductList link. 

		</div>
	</div>
	<div id="PromotionalChoices" class="method">
		<h4>
			<span title="System.Collections.Generic.List<NextCategoryChoice>">List&lt;NextCategoryChoice&gt;</span> <strong>PromotionalChoices</strong> get; set;
		</h4>
		<div class="content">Similar to a NextCategoryChoice, but without being contained in a parent NextClassificationChoice, this represents a cross-navigational
link to a promotional or similar item. This lives outside of a Classification because it is applicable to the NavigationChoice object as a whole. 

		</div>
	</div>
	<div id="QuickOrderChoices" class="method">
		<h4>
			<span title="System.Collections.Generic.List<NextCategoryChoice>">List&lt;NextCategoryChoice&gt;</span> <strong>QuickOrderChoices</strong> get; set;
		</h4>
		<div class="content">A link to a set of products which could be suggested for a Quick Order mechanic, and are drawn from the set of products within this NavigationChoice.
Similar to a NextCategoryChoice, but without being contained in a parent NextClassificationChoice. Identical in behaviour to the PromotionalChoices, but
probably will not have images. 

		</div>
	</div>
	<div id="RequestedSearch" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary.Products.Navigation/SearchTerms.htm">SearchTerms</a> <strong>RequestedSearch</strong> get; set;
		</h4>
		<div class="content">A structure which can be populated in the NavigationChoice in order to apply a search filter, by posting a NavigationChoice (empty except for RequestedSearch) to the Filter link. 

		</div>
	</div>
	<div id="Resources" class="method">
		<h4>
			<span title="System.Collections.Generic.List<Link_V1>">List&lt;Link_V1&gt;</span> <strong>Resources</strong> get; set;
		</h4>
		<div class="content">A list of links to product resources such as the primary image, PDFs, secondary images.
Special Identifiers are used for the links: "photograph" is for the product photograph Jpeg. "specification" is for a PDF spec sheet. 

		</div>
	</div>
	<div id="Searches" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>Searches</strong> get; set;
		</h4>
		<div class="content">A link to which the NavigationChoice can be POSTed back to itself, with the RequestedSearch structure populated, to receive the same NavigationChoice back but filtered appropriately for the search.
If the RequestedSearch is empty, then any already applied search filter will be removed and the original NavigationChoice will be returned back again. <blockquote class="remarks">
  application/x.pws.products.navigation.navigationchoice-v1 
</blockquote>

		</div>
	</div>
	<div id="VisualFlags" class="method">
		<h4>
			<span title="System.Collections.Generic.List<VisualFlag>">List&lt;VisualFlag&gt;</span> <strong>VisualFlags</strong> get; set;
		</h4>
		<div class="content">Visual flags to apply at this level. 

		</div>
	</div>
	<div id="WebPageLinks" class="method">
		<h4>
			<span title="System.Collections.Generic.List<WebPageLink>">List&lt;WebPageLink&gt;</span> <strong>WebPageLinks</strong> get; set;
		</h4>
		<div class="content">Links to related human-readable information on web pages. Zero or more may be present. 

		</div>
	</div>
	</section>
	</article><footer>
	<span id="version">Built from v1.0.0.0 of Pws.Clients.RestLibrary</span>
	<span id="docu-link">
		Generated by <a href="http://docu.jagregory.com">docu</a>
	</span>
</footer>
  </body>
</html>